Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

help descriptions for better clarity #635

Merged
merged 3 commits into from
Oct 9, 2024
Merged

help descriptions for better clarity #635

merged 3 commits into from
Oct 9, 2024

Conversation

noborus
Copy link
Owner

@noborus noborus commented Oct 9, 2024

  • Improved command-line help and help descriptions for better clarity.
  • Fixed typos in various files.

- Improved command-line help and help descriptions for better clarity.
- Fixed typos in various files.
Copy link
Contributor

@ccoVeille ccoVeille left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor remarks and suggestions

@@ -278,14 +278,14 @@ func Test_stripBackSlash(t *testing.T) {
want string
}{
{
name: "nonEsacpe",
name: "nonEsacape",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This no?

Suggested change
name: "nonEsacape",
name: "nonEscape",

Or is it intentional?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops

args: args{
str: "\test",
},
want: "\test",
},
{
name: "nonEsacpe2",
name: "nonEsacape2",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as #635 (comment)

@@ -365,7 +365,7 @@ func (k KeyBind) String() string {
k.writeKeyBind(&b, actionLastSection, "last section")
k.writeKeyBind(&b, actionFollowSection, "follow section mode toggle")
k.writeKeyBind(&b, actionSectionNum, "number of section header lines")
k.writeKeyBind(&b, actionHideOther, "toggle hide other section")
k.writeKeyBind(&b, actionHideOther, "hide other section toggle")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's unclear if you hide other section,or iftou hide a section named "other"

So maybe this

Suggested change
k.writeKeyBind(&b, actionHideOther, "hide other section toggle")
k.writeKeyBind(&b, actionHideOther,`"hide "other" section toggle`)

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@@ -278,14 +278,14 @@ func Test_stripBackSlash(t *testing.T) {
want string
}{
{
name: "nonEsacpe",
name: "nonEscaape",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot stop laughing, thanks @noborus

Try this

Suggested change
name: "nonEscaape",
name: "nonEscape",

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...sorry

@noborus
Copy link
Owner Author

noborus commented Oct 9, 2024

Thank you.

@noborus noborus merged commit 092323c into master Oct 9, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants